Skip to content

toast api docs#649

Open
avoguru wants to merge 4 commits intomainfrom
toast-api
Open

toast api docs#649
avoguru wants to merge 4 commits intomainfrom
toast-api

Conversation

@avoguru
Copy link
Contributor

@avoguru avoguru commented Jan 14, 2026

Note

Introduces hospitality docs and Toast POS API tooling documentation.

  • Adds hospitality category to app/en/resources/integrations/_meta.tsx ("Retail & Hospitality")
  • Creates app/en/resources/integrations/hospitality/toast-api/page.mdx with comprehensive ToastApi docs: auth (client credentials), scope coverage, and tool references (orders, menus, kitchen, labor, inventory, cash mgmt, restaurant info)
  • Adds app/en/resources/integrations/hospitality/_meta.tsx to register Toast POS API
  • Updates public/llms.txt to include the new ToastApi docs link

Written by Cursor Bugbot for commit 911b05f. This will update automatically on new commits. Configure here.

@avoguru avoguru requested a review from byrro January 14, 2026 21:00
@vercel
Copy link

vercel bot commented Jan 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Feb 16, 2026 6:51pm

Request Review

@avoguru avoguru enabled auto-merge (squash) January 22, 2026 21:50
@avoguru avoguru disabled auto-merge January 22, 2026 21:50
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style Review

Found 4 style suggestion(s).

Powered by Vale + Claude


<Callout type="info">
Bearer tokens are fetched automatically for each API request using your client credentials.
You don't need to manage token expiration or refresh - it's handled for you!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Google.Exclamation: Removed exclamation point from documentation text

Suggested change
You don't need to manage token expiration or refresh - it's handled for you!
You don't need to manage token expiration or refresh - it's handled for you.

**Parameters**

- **restaurant_external_id** (`string`, required): The Toast platform GUID for the restaurant.
- **business_date** (`string`, required): The business date in YYYYMMDD format (e.g., 20240115).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Google.Latin: Replaced 'e.g.' with 'for example'

Suggested change
- **business_date** (`string`, required): The business date in YYYYMMDD format (e.g., 20240115).
- **business_date** (`string`, required): The business date in YYYYMMDD format (for example, 20240115).

**Parameters**

- **restaurant_external_id** (`string`, required): The Toast platform GUID for the restaurant.
- **business_date** (`string`, required): The business date in YYYYMMDD format (e.g., 20240115).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Google.Latin: Replaced 'e.g.' with 'for example'

Suggested change
- **business_date** (`string`, required): The business date in YYYYMMDD format (e.g., 20240115).
- **business_date** (`string`, required): The business date in YYYYMMDD format (for example, 20240115).

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.

"toast-api": {
title: "Toast POS API",
},
};
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing default theme configuration in hospitality meta

Medium Severity

The hospitality/_meta.tsx file is missing the "*" default theme configuration that all other integration category meta files include. Every other category (databases, payments, entertainment, sales, customer-support, etc.) has a "*": { theme: { breadcrumb: true, toc: true, copyPage: true } } entry. Without this, the Toast API page will render without breadcrumb navigation, table of contents, and copy page functionality, making it inconsistent with all other integration pages.

Fix in Cursor Fix in Web

@vfanelle
Copy link
Contributor

vfanelle commented Feb 3, 2026

@avoguru the Toast starter toolkit docs look ready to merge. Want to go ahead and ship it?

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style Review

Found 2 style suggestion(s).

Powered by Vale + Claude

- **Cash Management**: View cash drawer entries and bank deposits
- **Restaurants**: Access restaurant configurations and management groups

This server is designed to streamline restaurant management and enable AI-powered automation of hospitality operations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Google.Passive: Changed passive voice 'is designed to' to active voice

Suggested change
This server is designed to streamline restaurant management and enable AI-powered automation of hospitality operations.
This server streamlines restaurant management and enables AI-powered automation of hospitality operations.

| `loyalty:read` | Not supported | See note below |

<Callout type="warning">
**Loyalty API Limitation**: The `loyalty:read` scope is not currently supported. The Toast Loyalty Integration API is a **webhook-based** system where Toast sends loyalty transaction events to your endpoint - it is not a read API that can be called to retrieve loyalty data. If you need loyalty functionality, contact Toast directly about their loyalty data access options.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arcade.WordList: Changed 'functionality' to 'feature' as specified in the word list rule

Suggested change
**Loyalty API Limitation**: The `loyalty:read` scope is not currently supported. The Toast Loyalty Integration API is a **webhook-based** system where Toast sends loyalty transaction events to your endpoint - it is not a read API that can be called to retrieve loyalty data. If you need loyalty functionality, contact Toast directly about their loyalty data access options.
**Loyalty API Limitation**: The `loyalty:read` scope is not currently supported. The Toast Loyalty Integration API is a **webhook-based** system where Toast sends loyalty transaction events to your endpoint - it is not a read API that can retrieve loyalty data. If you need loyalty feature, contact Toast directly about their loyalty data access options.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments